Skip to content

feat: add PDF research agent example using bindufy#328

Open
ne-ey wants to merge 2 commits intoGetBindu:mainfrom
ne-ey:add-pdf-research-agent-example
Open

feat: add PDF research agent example using bindufy#328
ne-ey wants to merge 2 commits intoGetBindu:mainfrom
ne-ey:add-pdf-research-agent-example

Conversation

@ne-ey
Copy link
Contributor

@ne-ey ne-ey commented Mar 5, 2026

Summary

  • Problem:
    There was no beginner example demonstrating how to build a document research agent that processes PDFs and raw text using Bindu.

  • Why it matters:
    Developers learning Bindu need a clear real-world example showing how an AI agent can be converted into a live service using bindufy().

  • What changed:
    Added a new example agent pdf_research_agent.py under examples/beginner/.
    The agent accepts either a PDF file path or raw document text and returns a structured summary.

  • What did NOT change:
    No changes were made to core Bindu functionality, APIs, storage, or scheduler components.


Change Type

  • Feature
  • Documentation

Scope

  • Documentation
  • CLI / utilities

Linked Issue/PR

None


User-Visible / Behavior Changes

A new beginner example agent is available:

examples/beginner/pdf_research_agent.py

This demonstrates how to:

  • read PDF content using pypdf
  • process document text with an LLM agent
  • expose the agent as a live microservice using bindufy()

Security Impact

New permissions/capabilities? No
Secrets handling changed? No
New network calls? No
Database changes? No
Auth changes? No


Verification

Environment

OS: Windows 11
Python: 3.13
Storage backend: InMemoryStorage
Scheduler backend: InMemoryScheduler

Steps to Test

  1. Run the agent

python pdf_research_agent.py

  1. Send a request using curl

curl -X POST http://localhost:3775/

  1. Retrieve task result using tasks/get.

Expected Behavior

Agent returns a structured summary of the provided document text or PDF content.

Actual Behavior

Agent successfully returns summarized output through the Bindu task system.


Human Verification

Verified scenarios:

  • Agent starts successfully
  • JSON-RPC request accepted
  • Task completes and returns result

Edge cases checked:

  • Raw text input
  • Long document input

Not verified:

  • Very large PDFs

Compatibility / Migration

Backward compatible: Yes


Risks and Mitigations

None


Checklist

  • Tests pass locally
  • Human verification completed
  • Backward compatibility considered

@ne-ey
Copy link
Contributor Author

ne-ey commented Mar 5, 2026

I built this example while learning the Bindu workflow
(bindufy → JSON-RPC message → task lifecycle).

If example agents are not the right direction, I'm happy to
work on an issue instead. I'll take a look through the open issues
and pick something meaningful to contribute.

@ne-ey ne-ey force-pushed the add-pdf-research-agent-example branch from c33d2c4 to a149819 Compare March 5, 2026 13:59
Copy link
Contributor

@Paraschamoli Paraschamoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ne-ey use openrouter api key also this is a good agent so don't put it inside beginner make a different folder for it with skill.yaml, readme ,.env.example you can use other agent for refrence

@ne-ey
Copy link
Contributor Author

ne-ey commented Mar 20, 2026

@ne-ey use openrouter api key also this is a good agent so don't put it inside beginner make a different folder for it with skill.yaml, readme ,.env.example you can use other agent for refrence

Thanks for the suggestion!! that makes sense, i'll move this out of the beginner folder and restructure it as a proper standalone agent example....and i'll also add the required files and switch to using OPENROUTER
sure i'll take reference from the existing agents in the repo and update this PR accordingly!

@ne-ey
Copy link
Contributor Author

ne-ey commented Mar 23, 2026

@Paraschamoli
updated the agent as suggested:

  • moved it out of beginner into a standalone folder
  • added skill.yaml, README, and .env.example
  • switched to OpenRouter

Let me know if anything else needs changes!
Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants